<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>helloworlddialogplugin.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_demos_editor_helloworlddialogplugin.js.html">helloworlddialogplugin.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2008 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview An example of how to write a dialog plugin.
<a name="line17"></a> *
<a name="line18"></a> */
<a name="line19"></a>
<a name="line20"></a>goog.provide(&#39;goog.demos.editor.HelloWorldDialogPlugin&#39;);
<a name="line21"></a>goog.provide(&#39;goog.demos.editor.HelloWorldDialogPlugin.Command&#39;);
<a name="line22"></a>
<a name="line23"></a>goog.require(&#39;goog.demos.editor.HelloWorldDialog&#39;);
<a name="line24"></a>goog.require(&#39;goog.dom.TagName&#39;);
<a name="line25"></a>goog.require(&#39;goog.editor.plugins.AbstractDialogPlugin&#39;);
<a name="line26"></a>goog.require(&#39;goog.editor.range&#39;);
<a name="line27"></a>goog.require(&#39;goog.functions&#39;);
<a name="line28"></a>goog.require(&#39;goog.ui.editor.AbstractDialog.EventType&#39;);
<a name="line29"></a>
<a name="line30"></a>
<a name="line31"></a>// *** Public interface ***************************************************** //
<a name="line32"></a>
<a name="line33"></a>/**
<a name="line34"></a> * A plugin that opens the hello world dialog.
<a name="line35"></a> * @constructor
<a name="line36"></a> * @extends {goog.editor.plugins.AbstractDialogPlugin}
<a name="line37"></a> */
<a name="line38"></a>goog.demos.editor.HelloWorldDialogPlugin = function() {
<a name="line39"></a>  goog.editor.plugins.AbstractDialogPlugin.call(this,
<a name="line40"></a>      goog.demos.editor.HelloWorldDialogPlugin.Command.HELLO_WORLD_DIALOG);
<a name="line41"></a>};
<a name="line42"></a>goog.inherits(goog.demos.editor.HelloWorldDialogPlugin,
<a name="line43"></a>              goog.editor.plugins.AbstractDialogPlugin);
<a name="line44"></a>
<a name="line45"></a>/**
<a name="line46"></a> * Commands implemented by this plugin.
<a name="line47"></a> * @enum {string}
<a name="line48"></a> */
<a name="line49"></a>goog.demos.editor.HelloWorldDialogPlugin.Command = {
<a name="line50"></a>  HELLO_WORLD_DIALOG: &#39;helloWorldDialog&#39;
<a name="line51"></a>};
<a name="line52"></a>
<a name="line53"></a>/** @override */
<a name="line54"></a>goog.demos.editor.HelloWorldDialogPlugin.prototype.getTrogClassId =
<a name="line55"></a>    goog.functions.constant(&#39;HelloWorldDialog&#39;);
<a name="line56"></a>
<a name="line57"></a>
<a name="line58"></a>// *** Protected interface ************************************************** //
<a name="line59"></a>
<a name="line60"></a>/**
<a name="line61"></a> * Creates a new instance of the dialog and registers for the relevant events.
<a name="line62"></a> * @param {goog.dom.DomHelper} dialogDomHelper The dom helper to be used to
<a name="line63"></a> *     create the dialog.
<a name="line64"></a> * @return {goog.demos.editor.HelloWorldDialog} The dialog.
<a name="line65"></a> * @override
<a name="line66"></a> * @protected
<a name="line67"></a> */
<a name="line68"></a>goog.demos.editor.HelloWorldDialogPlugin.prototype.createDialog = function(
<a name="line69"></a>    dialogDomHelper) {
<a name="line70"></a>  var dialog = new goog.demos.editor.HelloWorldDialog(dialogDomHelper);
<a name="line71"></a>  dialog.addEventListener(goog.ui.editor.AbstractDialog.EventType.OK,
<a name="line72"></a>                          this.handleOk_,
<a name="line73"></a>                          false,
<a name="line74"></a>                          this);
<a name="line75"></a>  return dialog;
<a name="line76"></a>};
<a name="line77"></a>
<a name="line78"></a>
<a name="line79"></a>// *** Private implementation *********************************************** //
<a name="line80"></a>
<a name="line81"></a>/**
<a name="line82"></a> * Handles the OK event from the dialog by inserting the hello world message
<a name="line83"></a> * into the field.
<a name="line84"></a> * @param {goog.demos.editor.HelloWorldDialog.OkEvent} e OK event object.
<a name="line85"></a> * @private
<a name="line86"></a> */
<a name="line87"></a>goog.demos.editor.HelloWorldDialogPlugin.prototype.handleOk_ = function(e) {
<a name="line88"></a>  // First restore the selection so we can manipulate the field&#39;s content
<a name="line89"></a>  // according to what was selected.
<a name="line90"></a>  this.restoreOriginalSelection();
<a name="line91"></a>
<a name="line92"></a>  // Notify listeners that the field&#39;s contents are about to change.
<a name="line93"></a>  this.getFieldObject().dispatchBeforeChange();
<a name="line94"></a>
<a name="line95"></a>  // Now we can clear out what was previously selected (if anything).
<a name="line96"></a>  var range = this.getFieldObject().getRange();
<a name="line97"></a>  range.removeContents();
<a name="line98"></a>  // And replace it with a span containing our hello world message.
<a name="line99"></a>  var createdNode = this.getFieldDomHelper().createDom(goog.dom.TagName.SPAN,
<a name="line100"></a>                                                       null,
<a name="line101"></a>                                                       e.message);
<a name="line102"></a>  createdNode = range.insertNode(createdNode, false);
<a name="line103"></a>  // Place the cursor at the end of the new text node (false == to the right).
<a name="line104"></a>  goog.editor.range.placeCursorNextTo(createdNode, false);
<a name="line105"></a>
<a name="line106"></a>  // Notify listeners that the field&#39;s selection has changed.
<a name="line107"></a>  this.getFieldObject().dispatchSelectionChangeEvent();
<a name="line108"></a>  // Notify listeners that the field&#39;s contents have changed.
<a name="line109"></a>  this.getFieldObject().dispatchChange();
<a name="line110"></a>};
</pre>


</body>
</html>
